Skip to main content

Partial Status

The Partial Status API provides a summarized view of message delivery metrics for a specific transaction. It shows the count of messages in various states like attempted, sent, delivered, read, or failed.

Request Syntax​

GET api/v2/message/Business ID/status/<TRANSACTION ID>/partial?apikey=<API KEY>

Request Body​

{
    "attempted": 1,
    "failed": 0,
    "error": 0,
    "accepted": 0,
    "sent": 0,
    "delivered": 0,
    "read": 1
}

Response Body​

{
    "attempted": 1,
    "failed": 0,
    "error": 0,
    "accepted": 0,
    "sent": 0,
    "delivered": 0,
    "read": 1
}

Examples​

Example 1:​

curl --location 'https://alb-backend.msgkart.com/api/v2/message/Business ID/status/<TRANSACTION ID>/partial?apikey=<API KEY>' \
--data '
{
    "attempted": 1,
    "failed": 0,
    "error": 0,
    "accepted": 0,
    "sent": 0,
    "delivered": 0,
    "read": 1
}'